package org.apache.commons.graph.utils

import com.gitee.wsl.text.format.format

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
 * Code partially extracted from Google Collections
 */
object Assertions {
    /**
     * Ensures the truth of an expression involving one or more parameters to the
     * calling method.
     *
     * @param expression a boolean expression
     * @param errorMessageTemplate a template for the exception message should the
     * check fail. The message is formed by replacing each `%s`
     * placeholder in the template with an argument. These are matched by
     * position - the first `%s` gets `errorMessageArgs[0]`, etc.
     * Unmatched arguments will be appended to the formatted message in square
     * braces. Unmatched placeholders will be left as-is.
     * @param errorMessageArgs the arguments to be substituted into the message
     * template. Arguments are converted to strings using
     * [String.valueOf].
     * @throws IllegalArgumentException if `expression` is false
     * @throws NullPointerException if the check fails and either `errorMessageTemplate` or `errorMessageArgs` is null (don't let
     * this happen)
     */
    fun checkArgument(
        expression: Boolean,
        errorMessageTemplate: String,
        vararg errorMessageArgs: Any?
    ) {
        require(expression) { String.format(errorMessageTemplate, *errorMessageArgs) }
    }

    /**
     * Ensures that an object reference passed as a parameter to the calling
     * method is not null.
     *
     * @param reference an object reference
     * @param <T> the reference type
     * @param errorMessageTemplate a template for the exception message should the
     * check fail. The message is formed by replacing each `%s`
     * placeholder in the template with an argument. These are matched by
     * position - the first `%s` gets `errorMessageArgs[0]`, etc.
     * Unmatched arguments will be appended to the formatted message in square
     * braces. Unmatched placeholders will be left as-is.
     * @param errorMessageArgs the arguments to be substituted into the message
     * template. Arguments are converted to strings using
     * [String.valueOf].
     * @return the non-null reference that was validated
     * @throws NullPointerException if `reference` is null
    </T> */
    fun <T> checkNotNull(
        reference: T?,
        errorMessageTemplate: String,
        vararg errorMessageArgs: Any?
    ): T {
        if (reference == null) {
            // If either of these parameters is null, the right thing happens anyway
            throw NullPointerException(String.format(errorMessageTemplate, *errorMessageArgs))
        }
        return reference
    }

    /**
     * Ensures the truth of an expression involving the state of the calling
     * instance, but not involving any parameters to the calling method.
     *
     * @param expression a boolean expression
     * @param errorMessageTemplate a template for the exception message should the
     * check fail. The message is formed by replacing each `%s`
     * placeholder in the template with an argument. These are matched by
     * position - the first `%s` gets `errorMessageArgs[0]`, etc.
     * Unmatched arguments will be appended to the formatted message in square
     * braces. Unmatched placeholders will be left as-is.
     * @param errorMessageArgs the arguments to be substituted into the message template.
     * @throws IllegalStateException if `expression` is false
     * @throws NullPointerException if the check fails and either `errorMessageTemplate` or `errorMessageArgs` is null (don't let
     * this happen)
     */
    fun checkState(
        expression: Boolean,
        errorMessageTemplate: String,
        vararg errorMessageArgs: Any?
    ) {
        check(expression) { String.format(errorMessageTemplate, *errorMessageArgs) }
    }
}
